Class Callback

Summary

Fully Qualified Name: Laminas\Authentication\Adapter\Callback
Extends: AbstractAdapter

Description

Authentication Adapter authenticates using callback function.

The Callback function must return an identity on authentication success, and false on authentication failure.

Methods

Name Description Defined By
__construct() Callback
authenticate() Authenticate using the provided callback Callback
getCallback() Gets the value of callback. Callback
getCredential() Returns the credential of the account being authenticated, or NULL if none is set. AbstractAdapter
getIdentity() Returns the identity of the account being authenticated, or NULL if none is set. AbstractAdapter
setCallback() Sets the value of callback. Callback
setCredential() Sets the credential for binding AbstractAdapter
setIdentity() Sets the identity for binding AbstractAdapter

Method Details

__construct()

Parameter Name Type Description
$callback callable The

Returns:

authenticate()

Authenticate using the provided callback

Returns: \Result The authentication result

getCallback()

Gets the value of callback.

Returns: null|callable

getCredential()

Returns the credential of the account being authenticated, or NULL if none is set.

Returns: mixed

getIdentity()

Returns the identity of the account being authenticated, or NULL if none is set.

Returns: mixed

setCallback()

Sets the value of callback.

Parameter Name Type Description
$callback callable the

Returns:

setCredential()

Sets the credential for binding

Parameter Name Type Description
$credential mixed

Returns: self Provides a fluent interface

setIdentity()

Sets the identity for binding

Parameter Name Type Description
$identity mixed

Returns: self Provides a fluent interface

Top